<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: D:/Projects/MiXiM/extsrc/mixim/src/modules/netw/Flood.h Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00450.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">Flood.h</div>  </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode:c++ -*- ********************************************************</span>
<a name="l00002"></a>00002 <span class="comment"> * file:        Flood.h</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * author:      Daniel Willkomm</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * copyright:   (C) 2004 Telecommunication Networks Group (TKN) at</span>
<a name="l00007"></a>00007 <span class="comment"> *              Technische Universitaet Berlin, Germany.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> *              This program is free software; you can redistribute it </span>
<a name="l00010"></a>00010 <span class="comment"> *              and/or modify it under the terms of the GNU General Public </span>
<a name="l00011"></a>00011 <span class="comment"> *              License as published by the Free Software Foundation; either</span>
<a name="l00012"></a>00012 <span class="comment"> *              version 2 of the License, or (at your option) any later </span>
<a name="l00013"></a>00013 <span class="comment"> *              version.</span>
<a name="l00014"></a>00014 <span class="comment"> *              For further information see file COPYING </span>
<a name="l00015"></a>00015 <span class="comment"> *              in the top level directory</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> ***************************************************************************</span>
<a name="l00018"></a>00018 <span class="comment"> * part of:     framework implementation developed by tkn</span>
<a name="l00019"></a>00019 <span class="comment"> * description: a simple flooding protocol</span>
<a name="l00020"></a>00020 <span class="comment"> *              the user can decide whether to use plain flooding or not</span>
<a name="l00021"></a>00021 <span class="comment"> **************************************************************************/</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _FLOOD_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _FLOOD_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;list&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;MiXiMDefs.h&quot;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &quot;BaseNetwLayer.h&quot;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &quot;SimpleAddress.h&quot;</span>
<a name="l00031"></a>00031 
<a name="l00051"></a><a class="code" href="a00094.html">00051</a> <span class="keyword">class </span>MIXIM_API <a class="code" href="a00094.html" title="A simple flooding protocol.">Flood</a> : <span class="keyword">public</span> <a class="code" href="a00028.html" title="Base class for the network layer.">BaseNetwLayer</a>
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="keyword">protected</span>:
<a name="l00055"></a><a class="code" href="a00094.html#a5fbbab943e750dc83ed4cb6450b83ea7">00055</a>     <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="a00094.html#a5fbbab943e750dc83ed4cb6450b83ea7" title="Network layer sequence number.">seqNum</a>;
<a name="l00056"></a>00056 
<a name="l00058"></a><a class="code" href="a00094.html#ade22f0280705a8bc6ffbcddeb53a13e2">00058</a>     <span class="keywordtype">int</span> <a class="code" href="a00094.html#ade22f0280705a8bc6ffbcddeb53a13e2" title="Default time-to-live (ttl) used for this module.">defaultTtl</a>;
<a name="l00059"></a>00059 
<a name="l00061"></a><a class="code" href="a00094.html#a475a6974782a10907352b83c18b63a21">00061</a>     <span class="keywordtype">bool</span> <a class="code" href="a00094.html#a475a6974782a10907352b83c18b63a21" title="Defines whether to use plain flooding or not.">plainFlooding</a>;
<a name="l00062"></a>00062 
<a name="l00063"></a><a class="code" href="a00034.html">00063</a>     <span class="keyword">class </span><a class="code" href="a00034.html">Bcast</a> {
<a name="l00064"></a>00064     <span class="keyword">public</span>:
<a name="l00065"></a>00065         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>    seqNum;
<a name="l00066"></a>00066         <a class="code" href="a00117.html#ad85cd9e8d9e7e9cd5d02dd740c4a12a4" title="Type definition for a L3 (Network) address.">LAddress::L3Type</a> srcAddr;
<a name="l00067"></a>00067         simtime_t        delTime;
<a name="l00068"></a>00068     <span class="keyword">public</span>:
<a name="l00069"></a>00069         <a class="code" href="a00034.html">Bcast</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> n=0, <span class="keyword">const</span> <a class="code" href="a00117.html#ad85cd9e8d9e7e9cd5d02dd740c4a12a4" title="Type definition for a L3 (Network) address.">LAddress::L3Type</a>&amp; s = <a class="code" href="a00117.html#a629f951ff7bc5f42e945bbc5573c4a0f" title="NULL address for L3 addresses.">LAddress::L3NULL</a>,  simtime_t_cref d=SIMTIME_ZERO) :
<a name="l00070"></a>00070             seqNum(n), srcAddr(s), delTime(d) {
<a name="l00071"></a>00071         }
<a name="l00072"></a>00072     };
<a name="l00073"></a>00073 
<a name="l00074"></a>00074     <span class="keyword">typedef</span> std::list&lt;Bcast&gt; cBroadcastList;
<a name="l00075"></a>00075 
<a name="l00077"></a><a class="code" href="a00094.html#aa791a274b5cca9a70f8a484d0b4d9f25">00077</a>     cBroadcastList <a class="code" href="a00094.html#aa791a274b5cca9a70f8a484d0b4d9f25" title="List of already broadcasted messages.">bcMsgs</a>;
<a name="l00078"></a>00078 
<a name="l00083"></a><a class="code" href="a00094.html#a8573f479f7cebbcf51efc90d5068b4a3">00083</a>     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="a00094.html#a8573f479f7cebbcf51efc90d5068b4a3" title="Max number of entries in the list of already broadcasted messages.">bcMaxEntries</a>;
<a name="l00084"></a>00084 
<a name="l00089"></a><a class="code" href="a00094.html#a0ebe4588526fe16bede5b8fb75506265">00089</a>     simtime_t <a class="code" href="a00094.html#a0ebe4588526fe16bede5b8fb75506265" title="Time after which an entry for an already broadcasted msg can be deleted.">bcDelTime</a>;
<a name="l00090"></a>00090 
<a name="l00091"></a>00091 <span class="keyword">public</span>:
<a name="l00092"></a>00092     <a class="code" href="a00094.html" title="A simple flooding protocol.">Flood</a>()
<a name="l00093"></a>00093       : <a class="code" href="a00028.html" title="Base class for the network layer.">BaseNetwLayer</a>()
<a name="l00094"></a>00094       , seqNum(0)
<a name="l00095"></a>00095       , defaultTtl(0)
<a name="l00096"></a>00096       , plainFlooding(false)
<a name="l00097"></a>00097       , bcMsgs()
<a name="l00098"></a>00098       , bcMaxEntries(0)
<a name="l00099"></a>00099       , bcDelTime()
<a name="l00100"></a>00100       , nbDataPacketsReceived(0)
<a name="l00101"></a>00101       , nbDataPacketsSent(0)
<a name="l00102"></a>00102       , nbDataPacketsForwarded(0)
<a name="l00103"></a>00103       , nbHops(0)
<a name="l00104"></a>00104     {}
<a name="l00105"></a>00105 
<a name="l00107"></a>00107     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00028.html#a1e521b5549bfe29ae94d95265c0fe8d2" title="Initialization of the module and some variables.">initialize</a>(<span class="keywordtype">int</span>);
<a name="l00108"></a>00108     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00025.html#a5ab11502dbeeea89693d29841376a2f7" title="Called when the simulation has finished.">finish</a>();    
<a name="l00109"></a>00109 
<a name="l00110"></a>00110 <span class="keyword">protected</span>:
<a name="l00111"></a>00111 
<a name="l00112"></a>00112     <span class="keywordtype">long</span> nbDataPacketsReceived;
<a name="l00113"></a>00113     <span class="keywordtype">long</span> nbDataPacketsSent;
<a name="l00114"></a>00114     <span class="keywordtype">long</span> nbDataPacketsForwarded;
<a name="l00115"></a>00115     <span class="keywordtype">long</span> nbHops;
<a name="l00116"></a>00116 
<a name="l00118"></a>00118     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00028.html#a0b473fbb2517ac7b0c633afdb002c269" title="Handle messages from upper layer.">handleUpperMsg</a>(cMessage *);
<a name="l00119"></a>00119 
<a name="l00121"></a>00121     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00028.html#a58afc64e0a96fe4d80d6b9f53cfd53c6" title="Handle messages from lower layer.">handleLowerMsg</a>(cMessage *);
<a name="l00122"></a>00122 
<a name="l00124"></a><a class="code" href="a00094.html#ac684a409e61e05e4058e9846ad021ca9">00124</a>     <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="a00094.html#ac684a409e61e05e4058e9846ad021ca9" title="we have no self messages">handleSelfMsg</a>(cMessage* <span class="comment">/*msg*/</span>) {};
<a name="l00125"></a>00125     
<a name="l00127"></a>00127     <span class="keywordtype">bool</span> notBroadcasted( netwpkt_ptr_t );
<a name="l00128"></a>00128 
<a name="l00129"></a>00129     <span class="comment">//overloading encaps method</span>
<a name="l00130"></a>00130     <span class="keyword">virtual</span> netwpkt_ptr_t <a class="code" href="a00028.html#aad9d232f77fa033ffa2f1e7abe8e4af6" title="Encapsulate higher layer packet into an NetwPkt.">encapsMsg</a>(cPacket*);
<a name="l00131"></a>00131 };
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>Flood.h</b>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:30 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
